Skip to content

[codex] docs: add README TOC automation#79

Draft
DMontgomery40 wants to merge 2 commits intooptskug:mainfrom
DMontgomery40:codex/add-readme-toc-automation
Draft

[codex] docs: add README TOC automation#79
DMontgomery40 wants to merge 2 commits intooptskug:mainfrom
DMontgomery40:codex/add-readme-toc-automation

Conversation

@DMontgomery40
Copy link
Copy Markdown

What changed

  • add a small Python script that keeps the README table of contents synchronized inside explicit markers
  • add a regression-check script for the new README note and fork freshness badges
  • add GitHub Actions workflows to validate the README on PRs and keep the TOC synchronized on main

Why

  • the repo is currently a single large README, so TOC drift is easy to introduce accidentally
  • the regression checks protect the newly added content from being dropped in later edits
  • CI makes the docs maintenance rules visible and repeatable for contributors

Stacking note

Validation

  • python3 scripts/sync_readme_toc.py --check
  • python3 scripts/check_readme_regressions.py
  • python3 -m compileall scripts
  • git diff --check

@nelsonjchen
Copy link
Copy Markdown
Member

I really like the TSK car warning's phrasing and would like to incorporate that, but the rest is a bit heavy and I would like to omit them. It's also kinda questionable to add a test for a doc like that but that's Codex for ya.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants